/*
 * Copyright (c) 2008 Benoit Bouchez, Nicolas Giard
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.noocodecommit.wicket.stuff.jquery.plugin;

import com.noocodecommit.wicket.stuff.jquery.JQOptions;

/**
 * Interface for JQuery DOM components
 * 
 * @author Benoit Bouchez
 * 
 */
public interface IJQPluginComponent
{
	/**
	 * @return this component document ready javascript call
	 * @param reset
	 *            true if widget reset if forced before init
	 */
	public String getWidgetReadyScript(boolean reset);

	/**
	 * After an ajax call from wicket on this component, we need to tell JQuery to re-init the component.
	 * 
	 * @return this component init script
	 */
	public String getAfterAjaxUpdateScript();

	/**
	 * Gets this component plugin
	 * 
	 * @return JQPlugin
	 */
	public JQPlugin getPlugin();

	/**
	 * Sets this component plugin
	 * 
	 * @param plugin
	 */
	public void setPlugin(JQPlugin plugin);

	/**
	 * Gets this component options
	 * 
	 * @return JQOptions
	 */
	public JQOptions getOptions();

	/**
	 * Sets this component options
	 * 
	 * @param options
	 */
	public void setOptions(JQOptions options);
}
